<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Returns a result set listing the foreign keys for a table</title>
 </head>
 <body class="docs"><div id="layout">
  <div id="layout-content"><div id="function.db2-foreign-keys" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">db2_foreign_keys</h1>
  <p class="verinfo">(PECL ibm_db2 &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">db2_foreign_keys</span> &mdash; <span class="dc-title">
   Returns a result set listing the foreign keys for a table
  </span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.db2-foreign-keys-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>db2_foreign_keys</strong></span>
    ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$qualifier</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$schema</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$table-name</code></span>
   ) : <span class="type">resource</span></div>



  <p class="para rdfs-comment">
   Returns a result set listing the foreign keys for a table.
  </p>

 </div>

 <div class="refsect1 parameters" id="refsect1-function.db2-foreign-keys-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>

    
     <dt>
<code class="parameter">connection</code></dt>

     <dd>

      <p class="para">
       A valid connection to an IBM DB2, Cloudscape, or Apache Derby database.
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">qualifier</code></dt>

     <dd>

      <p class="para">
       A qualifier for DB2 databases running on OS/390 or z/OS servers. For
       other databases, pass <strong><code>NULL</code></strong> or an empty string.
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">schema</code></dt>

     <dd>

      <p class="para">
       The schema which contains the tables. If <code class="parameter">schema</code>
       is <strong><code>NULL</code></strong>, <span class="function"><strong>db2_foreign_keys()</strong></span> matches the schema for
       the current connection.
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">table-name</code></dt>

     <dd>

      <p class="para">
       The name of the table.
      </p>
     </dd>

    
   </dl>

  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.db2-foreign-keys-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   Returns a statement resource with a result set containing rows describing
   the foreign keys for the specified table. The result set is composed of the
   following columns:
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Column name</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
       <tr>
        <td>PKTABLE_CAT</td>
        <td>
         Name of the catalog for the table containing the primary key. The
         value is NULL if this table does not have catalogs.
        </td>
       </tr>

       <tr>
        <td>PKTABLE_SCHEM</td>
        <td>
         Name of the schema for the table containing the primary key.
        </td>
       </tr>

       <tr>
        <td>PKTABLE_NAME</td>
        <td>Name of the table containing the primary key.</td>
       </tr>

       <tr>
        <td>PKCOLUMN_NAME</td>
        <td>Name of the column containing the primary key.</td>
       </tr>

       <tr>
        <td>FKTABLE_CAT</td>
        <td>
         Name of the catalog for the table containing the foreign key. The
         value is NULL if this table does not have catalogs.
        </td>
       </tr>

       <tr>
        <td>FKTABLE_SCHEM</td>
        <td>
         Name of the schema for the table containing the foreign key.
        </td>
       </tr>

       <tr>
        <td>FKTABLE_NAME</td>
        <td>Name of the table containing the foreign key.</td>
       </tr>

       <tr>
        <td>FKCOLUMN_NAME</td>
        <td>Name of the column containing the foreign key.</td>
       </tr>

       <tr>
        <td>KEY_SEQ</td>
        <td>1-indexed position of the column in the key.</td>
       </tr>

       <tr>
        <td>UPDATE_RULE</td>
        <td>
         Integer value representing the action applied to the foreign key
         when the SQL operation is UPDATE.
        </td>
       </tr>

       <tr>
        <td>DELETE_RULE</td>
        <td>
         Integer value representing the action applied to the foreign key
         when the SQL operation is DELETE.
        </td>
       </tr>

       <tr>
        <td>FK_NAME</td>
        <td>The name of the foreign key.</td>
       </tr>

       <tr>
        <td>PK_NAME</td>
        <td>The name of the primary key.</td>
       </tr>

       <tr>
        <td>DEFERRABILITY</td>
        <td>
         An integer value representing whether the foreign key deferrability is
         SQL_INITIALLY_DEFERRED, SQL_INITIALLY_IMMEDIATE, or
         SQL_NOT_DEFERRABLE.
        </td>
       </tr>

     </tbody>
    
   </table>


  </p>
 </div>


 

 <div class="refsect1 seealso" id="refsect1-function.db2-foreign-keys-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="function"><a href="db2_column_privileges.html" class="function" rel="rdfs-seeAlso">db2_column_privileges()</a> - Returns a result set listing the columns and associated privileges for a table</span></li>
    <li class="member"><span class="function"><a href="db2_columns.html" class="function" rel="rdfs-seeAlso">db2_columns()</a> - Returns a result set listing the columns and associated metadata for a table</span></li>
    <li class="member"><span class="function"><a href="db2_primary_keys.html" class="function" rel="rdfs-seeAlso">db2_primary_keys()</a> - Returns a result set listing primary keys for a table</span></li>
    <li class="member"><span class="function"><a href="db2_procedure_columns.html" class="function" rel="rdfs-seeAlso">db2_procedure_columns()</a> - Returns a result set listing stored procedure parameters</span></li>
    <li class="member"><span class="function"><a href="db2_procedures.html" class="function" rel="rdfs-seeAlso">db2_procedures()</a> - Returns a result set listing the stored procedures registered in a database</span></li>
    <li class="member"><span class="function"><a href="db2_special_columns.html" class="function" rel="rdfs-seeAlso">db2_special_columns()</a> - Returns a result set listing the unique row identifier columns for a table</span></li>
    <li class="member"><span class="function"><a href="db2_statistics.html" class="function" rel="rdfs-seeAlso">db2_statistics()</a> - Returns a result set listing the index and statistics for a table</span></li>
    <li class="member"><span class="function"><a href="db2_table_privileges.html" class="function" rel="rdfs-seeAlso">db2_table_privileges()</a> - Returns a result set listing the tables and associated privileges in a database</span></li>
    <li class="member"><span class="function"><a href="db2_tables.html" class="function" rel="rdfs-seeAlso">db2_tables()</a> - Returns a result set listing the tables and associated metadata in a database</span></li>
   </ul>
  </p>
 </div>


</div></div></div></body></html>